:lighter " WK"
(if which-key-mode
(progn
- (unless which-key--is-setup (which-key/setup))
+ (unless which-key--is-setup (which-key//setup))
;; reduce echo-keystrokes for minibuffer popup
;; (it can interfer if it's too slow)
(when (and (> echo-keystrokes 0)
(setq echo-keystrokes which-key-echo-keystrokes)
(message "Which-key-mode enabled (note echo-keystrokes changed from %s to %s)"
which-key--echo-keystrokes-backup echo-keystrokes))
- (add-hook 'pre-command-hook #'which-key/hide-popup)
- (add-hook 'focus-out-hook #'which-key/stop-open-timer)
- (add-hook 'focus-in-hook #'which-key/start-open-timer)
- (which-key/start-open-timer))
+ (add-hook 'pre-command-hook #'which-key//hide-popup)
+ (add-hook 'focus-out-hook #'which-key//stop-open-timer)
+ (add-hook 'focus-in-hook #'which-key//start-open-timer)
+ (which-key//start-open-timer))
;; make sure echo-keystrokes returns to original value
(setq echo-keystrokes which-key--echo-keystrokes-backup)
- (remove-hook 'pre-command-hook #'which-key/hide-popup)
- (remove-hook 'focus-out-hook #'which-key/stop-open-timer)
- (remove-hook 'focus-in-hook #'which-key/start-open-timer)
- (which-key/stop-open-timer)))
+ (remove-hook 'pre-command-hook #'which-key//hide-popup)
+ (remove-hook 'focus-out-hook #'which-key//stop-open-timer)
+ (remove-hook 'focus-in-hook #'which-key//start-open-timer)
+ (which-key//stop-open-timer)))
-(defun which-key/setup ()
+(defun which-key//setup ()
"Create buffer for which-key."
(setq which-key--buffer (get-buffer-create which-key-buffer-name))
(with-current-buffer which-key--buffer
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Functions for computing window sizes
-(defun which-key/text-width-to-total (text-width)
+(defun which-key//text-width-to-total (text-width)
"Convert window text-width to window total-width.
TEXT-WIDTH is the desired text width of the window. The function
calculates what total width is required for a window in the
(+ text-width
(/ (frame-fringe-width) char-width)
(/ (frame-scroll-bar-width) char-width)
- (if (which-key/char-enlarged-p) 1 0)
+ (if (which-key//char-enlarged-p) 1 0)
;; add padding to account for possible wide (unicode) characters
3)))
-(defun which-key/total-width-to-text (total-width)
+(defun which-key//total-width-to-text (total-width)
"Convert window total-width to window text-width.
TOTAL-WIDTH is the desired total width of the window. The function calculates
what text width fits such a window. The calculation considers possible fringes
(- total-width
(/ (frame-fringe-width) char-width)
(/ (frame-scroll-bar-width) char-width)
- (if (which-key/char-enlarged-p) 1 0)
+ (if (which-key//char-enlarged-p) 1 0)
;; add padding to account for possible wide (unicode) characters
3)))
-(defun which-key/char-enlarged-p (&optional frame)
+(defun which-key//char-enlarged-p (&optional frame)
(> (frame-char-width) (/ (float (frame-pixel-width)) (window-total-width (frame-root-window)))))
-(defun which-key/char-reduced-p (&optional frame)
+(defun which-key//char-reduced-p (&optional frame)
(< (frame-char-width) (/ (float (frame-pixel-width)) (window-total-width (frame-root-window)))))
-(defun which-key/char-exact-p (&optional frame)
+(defun which-key//char-exact-p (&optional frame)
(= (frame-char-width) (/ (float (frame-pixel-width)) (window-total-width (frame-root-window)))))
-(defun which-key/width-or-percentage-to-width (width-or-percentage)
+(defun which-key//width-or-percentage-to-width (width-or-percentage)
"Return window total width.
If WIDTH-OR-PERCENTAGE is a whole number, return it unchanged. Otherwise, it
should be a percentage (a number between 0 and 1) out of the frame's width.
width-or-percentage
(round (* width-or-percentage (window-total-width (frame-root-window))))))
-(defun which-key/height-or-percentage-to-height (height-or-percentage)
+(defun which-key//height-or-percentage-to-height (height-or-percentage)
"Return window total height.
If HEIGHT-OR-PERCENTAGE is a whole number, return it unchanged. Otherwise, it
should be a percentage (a number between 0 and 1) out of the frame's height.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Show/hide guide buffer
-(defun which-key/hide-popup ()
+(defun which-key//hide-popup ()
"This function is called to hide the which-key buffer."
(cl-case which-key-popup-type
- (minibuffer (which-key/hide-buffer-minibuffer))
- (side-window (which-key/hide-buffer-side-window))
- (frame (which-key/hide-buffer-frame))
+ (minibuffer (which-key//hide-buffer-minibuffer))
+ (side-window (which-key//hide-buffer-side-window))
+ (frame (which-key//hide-buffer-frame))
(custom (funcall #'which-key/custom-hide-popup-function))))
-(defun which-key/hide-buffer-minibuffer ()
+(defun which-key//hide-buffer-minibuffer ()
"Does nothing.
Stub for consistency with other hide-buffer functions."
nil)
-(defun which-key/hide-buffer-side-window ()
+(defun which-key//hide-buffer-side-window ()
"Hide which-key buffer when side-window popup is used."
(when (buffer-live-p which-key--buffer)
;; in case which-key buffer was shown in an existing window, `quit-window'
;; will re-show the previous buffer, instead of closing the window
(quit-windows-on which-key--buffer)))
-(defun which-key/hide-buffer-frame ()
+(defun which-key//hide-buffer-frame ()
"Hide which-key buffer when frame popup is used."
(when (frame-live-p which-key--frame)
(delete-frame which-key--frame)))
-(defun which-key/show-popup (act-popup-dim)
+(defun which-key//show-popup (act-popup-dim)
"Show the which-key buffer.
ACT-POPUP-DIM includes the dimensions, (height . width) of the
buffer text to be displayed in the popup. Return nil if no window
is shown, or if there is no need to start the closing timer."
(when (and (> (car act-popup-dim) 0) (> (cdr act-popup-dim) 0))
(cl-case which-key-popup-type
- (minibuffer (which-key/show-buffer-minibuffer act-popup-dim))
- (side-window (which-key/show-buffer-side-window act-popup-dim))
- (frame (which-key/show-buffer-frame act-popup-dim))
+ (minibuffer (which-key//show-buffer-minibuffer act-popup-dim))
+ (side-window (which-key//show-buffer-side-window act-popup-dim))
+ (frame (which-key//show-buffer-frame act-popup-dim))
(custom (funcall #'which-key/custom-show-popup-function act-popup-dim)))))
-(defun which-key/show-buffer-minibuffer (act-popup-dim)
+(defun which-key//show-buffer-minibuffer (act-popup-dim)
"Does nothing.
Stub for consistency with other show-buffer functions."
nil)
-(defun which-key/fit-buffer-to-window-horizontally (&optional window &rest params)
+(defun which-key//fit-buffer-to-window-horizontally (&optional window &rest params)
"Slightly modified version of `fit-buffer-to-window'.
Use &rest params because `fit-buffer-to-window' has a different
call signature in different emacs versions"
(let ((fit-window-to-buffer-horizontally t))
(apply #'fit-window-to-buffer window params)))
-(defun which-key/show-buffer-side-window (_act-popup-dim)
+(defun which-key//show-buffer-side-window (_act-popup-dim)
"Show which-key buffer when popup type is side-window."
(let* ((side which-key-side-window-location)
- (alist '((window-width . which-key/fit-buffer-to-window-horizontally)
+ (alist '((window-width . which-key//fit-buffer-to-window-horizontally)
(window-height . fit-window-to-buffer))))
;; Note: `display-buffer-in-side-window' and `display-buffer-in-major-side-window'
;; were added in Emacs 24.3
(display-buffer-reuse-window which-key--buffer alist)
(display-buffer-in-major-side-window which-key--buffer side 0 alist))))
-(defun which-key/show-buffer-frame (act-popup-dim)
+(defun which-key//show-buffer-frame (act-popup-dim)
"Show which-key buffer when popup type is frame."
(let* ((orig-window (selected-window))
(frame-height (+ (car act-popup-dim)
(new-window (if (and (frame-live-p which-key--frame)
(eq which-key--buffer
(window-buffer (frame-root-window which-key--frame))))
- (which-key/show-buffer-reuse-frame frame-height frame-width)
- (which-key/show-buffer-new-frame frame-height frame-width))))
+ (which-key//show-buffer-reuse-frame frame-height frame-width)
+ (which-key//show-buffer-new-frame frame-height frame-width))))
(when new-window
;; display successful
(setq which-key--frame (window-frame new-window))
new-window)))
-(defun which-key/show-buffer-new-frame (frame-height frame-width)
- "Helper for `which-key/show-buffer-frame'."
+(defun which-key//show-buffer-new-frame (frame-height frame-width)
+ "Helper for `which-key//show-buffer-frame'."
(let* ((frame-params `((height . ,frame-height)
(width . ,frame-width)
;; tell the window manager to respect the given sizes
(redirect-frame-focus (window-frame new-window) orig-frame)
new-window)))
-(defun which-key/show-buffer-reuse-frame (frame-height frame-width)
- "Helper for `which-key/show-buffer-frame'."
+(defun which-key//show-buffer-reuse-frame (frame-height frame-width)
+ "Helper for `which-key//show-buffer-frame'."
(let ((window
(display-buffer-reuse-window which-key--buffer
`((reusable-frames . ,which-key--frame)))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Max dimension of available window functions
-(defun which-key/popup-max-dimensions (selected-window-width)
+(defun which-key//popup-max-dimensions (selected-window-width)
"Dimesion functions should return the maximum possible (height
. width) of the intended popup. SELECTED-WINDOW-WIDTH is the
width of currently active window, not the which-key buffer
window."
(cl-case which-key-popup-type
- (minibuffer (which-key/minibuffer-max-dimensions))
- (side-window (which-key/side-window-max-dimensions))
- (frame (which-key/frame-max-dimensions))
+ (minibuffer (which-key//minibuffer-max-dimensions))
+ (side-window (which-key//side-window-max-dimensions))
+ (frame (which-key//frame-max-dimensions))
(custom (funcall #'which-key/custom-popup-max-dimensions-function selected-window-width))))
-(defun which-key/minibuffer-max-dimensions ()
+(defun which-key//minibuffer-max-dimensions ()
"Return max-dimensions of minibuffer (height . width).
Measured in lines and characters respectively."
(cons
;; width
(frame-text-cols)))
-(defun which-key/side-window-max-dimensions ()
+(defun which-key//side-window-max-dimensions ()
"Return max-dimensions of the side-window popup (height .
width) in lines and characters respectively."
(cons
(- (frame-height) (window-text-height (minibuffer-window)) 1) ;; 1 is a kludge to make sure there is no overlap
;; (window-mode-line-height which-key--window))
;; FIXME: change to something like (min which-*-height (calculate-max-height))
- (which-key/height-or-percentage-to-height which-key-side-window-max-height))
+ (which-key//height-or-percentage-to-height which-key-side-window-max-height))
;; width
(if (member which-key-side-window-location '(left right))
- (which-key/total-width-to-text (which-key/width-or-percentage-to-width
+ (which-key//total-width-to-text (which-key//width-or-percentage-to-width
which-key-side-window-max-width))
(frame-width))))
-(defun which-key/frame-max-dimensions ()
+(defun which-key//frame-max-dimensions ()
"Return max-dimensions of the frame popup (height .
width) in lines and characters respectively."
(cons which-key-frame-max-height which-key-frame-max-width))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Functions for retrieving and formatting keys
-(defun which-key/maybe-replace (string repl-alist &optional literal)
+(defun which-key//maybe-replace (string repl-alist &optional literal)
"Perform replacements on STRING.
REPL-ALIST is an alist where the car of each element is the text
to replace and the cdr is the replacement text. Unless LITERAL is
(replace-match (cdr repl) t literal new-string))))
new-string)))
-(defun which-key/maybe-replace-key-based (string keys)
+(defun which-key//maybe-replace-key-based (string keys)
"KEYS is a key sequence like \"C-c C-c\" and STRING is the
description that is possibly replaced using the
`which-key-key-based-description-replacement-alist'. Whether or
(str-res (cdr str-res))
(t string))))
-(defun which-key/propertize-key (key)
+(defun which-key//propertize-key (key)
"Add a face to KEY.
If KEY contains any \"special keys\" defined in
`which-key-special-keys' then truncate and add the corresponding
(substring key-w-face end (length key-w-face))))
key-w-face))))
-(defsubst which-key/truncate-description (desc)
+(defsubst which-key//truncate-description (desc)
"Truncate DESC description to `which-key-max-description-length'."
(if (> (length desc) which-key-max-description-length)
(concat (substring desc 0 which-key-max-description-length) "..")
(or (string-match-p "^\\(group:\\|Prefix\\)" description)
(keymapp (intern description))))
-(defun which-key/propertize-description (description group)
+(defun which-key//propertize-description (description group)
"Add face to DESCRIPTION where the face chosen depends on
whether the description represents a group or a command. Also
make some minor adjustments to the description string, like
(desc (if (string-match-p "^group:" desc)
(substring desc 6) desc))
(desc (if group (concat "+" desc) desc))
- (desc (which-key/truncate-description desc)))
+ (desc (which-key//truncate-description desc)))
(propertize desc 'face
(if group
'which-key-group-description-face
'which-key-command-description-face))))
-(defun which-key/format-and-replace (unformatted prefix-keys)
+(defun which-key//format-and-replace (unformatted prefix-keys)
"Take a list of (key . desc) cons cells in UNFORMATTED, add
faces and perform replacements according to the three replacement
alists. Returns a list (key separator description)."
(desc (cdr key-desc-cons))
(group (which-key//group-p desc))
(keys (concat prefix-keys " " key))
- (key (which-key/maybe-replace
+ (key (which-key//maybe-replace
key which-key-key-replacement-alist))
- (desc (which-key/maybe-replace
+ (desc (which-key//maybe-replace
desc which-key-description-replacement-alist))
- (desc (which-key/maybe-replace-key-based desc keys))
- (key-w-face (which-key/propertize-key key))
- (desc-w-face (which-key/propertize-description desc group)))
+ (desc (which-key//maybe-replace-key-based desc keys))
+ (key-w-face (which-key//propertize-key key))
+ (desc-w-face (which-key//propertize-description desc group)))
(list key-w-face sep-w-face desc-w-face)))
unformatted)))
-(defun which-key/get-formatted-key-bindings (buffer key-seq)
+(defun which-key//get-formatted-key-bindings (buffer key-seq)
"Uses `describe-buffer-bindings' to collect the key bindings in
BUFFER that follow the key sequence KEY-SEQ."
(let ((key-str-qt (regexp-quote (key-description key-seq)))
desc-match (match-string 2))
(cl-pushnew (cons key-match desc-match) unformatted
:test (lambda (x y) (string-equal (car x) (car y))))))
- (which-key/format-and-replace unformatted (key-description key-seq))))
+ (which-key//format-and-replace unformatted (key-description key-seq))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Functions for laying out which-key buffer pages
0 (length (substring-no-properties (nth index y))))))
keys :initial-value 0))
-(defun which-key/create-page-vertical (keys max-lines max-width prefix-width)
+(defun which-key//create-page-vertical (keys max-lines max-width prefix-width)
"Format KEYS into string representing a single page of text.
Creates columns (padded to be of uniform width) of length
MAX-LINES until keys run out or MAX-WIDTH is reached. A non-zero
(setq page (which-key//join-columns all-columns))
(list page act-n-lines act-width rem-keys (- n-keys (length rem-keys)))))
-(defun which-key/create-page (keys max-lines max-width prefix-width &optional vertical use-status-key page-n)
+(defun which-key//create-page (keys max-lines max-width prefix-width &optional vertical use-status-key page-n)
"Create a page of KEYS with parameters MAX-LINES, MAX-WIDTH,PREFIX-WIDTH.
Use as many keys as possible. Use as few lines as possible unless
VERTICAL is non-nil. USE-STATUS-KEY inserts an informative
allows for the informative message to reference the current page
number."
(let* ((n-keys (length keys))
- (first-try (which-key/create-page-vertical keys max-lines max-width prefix-width))
+ (first-try (which-key//create-page-vertical keys max-lines max-width prefix-width))
(n-rem-keys (length (nth 3 first-try)))
(status-key-i (- n-keys n-rem-keys 1))
(next-try-lines max-lines)
(cons 'status (propertize
(format "%s keys not shown" (1+ n-rem-keys))
'face 'font-lock-comment-face)))
- (which-key/create-page-vertical (-insert-at status-key-i status-key keys)
+ (which-key//create-page-vertical (-insert-at status-key-i status-key keys)
max-lines max-width prefix-width))
((or vertical (> n-rem-keys 0) (= 1 max-lines))
first-try)
(setq iter-n (1+ iter-n)
prev-try next-try
next-try-lines (- next-try-lines 1)
- next-try (which-key/create-page-vertical
+ next-try (which-key//create-page-vertical
keys next-try-lines max-width prefix-width)
n-rem-keys (length (nth 3 next-try))
found (or (= next-try-lines 0) (> n-rem-keys 0))))
prev-try))))
-(defun which-key/populate-buffer (prefix-keys formatted-keys sel-win-width)
+(defun which-key//populate-buffer (prefix-keys formatted-keys sel-win-width)
"Insert FORMATTED-KEYS into which-key buffer.
PREFIX-KEYS may be inserted into the buffer depending on the
value of `which-key-show-prefix'. SEL-WIN-WIDTH is passed to
-`which-key/popup-max-dimensions'."
+`which-key//popup-max-dimensions'."
(let* ((vertical (and (eq which-key-popup-type 'side-window)
(member which-key-side-window-location '(left right))))
- (prefix-w-face (which-key/propertize-key prefix-keys))
+ (prefix-w-face (which-key//propertize-key prefix-keys))
(prefix-len (+ 2 (length (substring-no-properties prefix-w-face))))
(prefix-string (when which-key-show-prefix
(if (eq which-key-show-prefix 'left)
(concat prefix-w-face " ")
(concat prefix-w-face "-\n"))))
- (max-dims (which-key/popup-max-dimensions sel-win-width))
+ (max-dims (which-key//popup-max-dimensions sel-win-width))
(max-lines (when (car max-dims) (car max-dims)))
(prefix-width (if (eq which-key-show-prefix 'left) prefix-len 0))
(avl-width (when (cdr max-dims) (cdr max-dims)))
max-pages-reached)
(while (and keys-rem (not max-pages-reached) (not no-room))
(setq page-n (1+ page-n)
- page-res (which-key/create-page keys-rem
+ page-res (which-key//create-page keys-rem
max-lines avl-width prefix-width
vertical which-key-show-remaining-keys page-n))
(push page-res pages)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Update
-(defun which-key/update ()
+(defun which-key//update ()
"Fill `which-key--buffer' with key descriptions and reformat.
Finally, show the buffer."
(let ((prefix-keys (this-single-command-keys)))
(keymapp (key-binding prefix-keys)))
(let* ((buf (current-buffer))
;; get formatted key bindings
- (formatted-keys (which-key/get-formatted-key-bindings
+ (formatted-keys (which-key//get-formatted-key-bindings
buf prefix-keys))
;; populate target buffer
- (popup-act-dim (which-key/populate-buffer
+ (popup-act-dim (which-key//populate-buffer
(key-description prefix-keys)
formatted-keys (window-width))))
;; show buffer
- (which-key/show-popup popup-act-dim)))))
+ (which-key//show-popup popup-act-dim)))))
;; Timers
-(defun which-key/start-open-timer ()
- "Activate idle timer to trigger `which-key/update'."
- (which-key/stop-open-timer) ; start over
+(defun which-key//start-open-timer ()
+ "Activate idle timer to trigger `which-key//update'."
+ (which-key//stop-open-timer) ; start over
(setq which-key--open-timer
- (run-with-idle-timer which-key-idle-delay t 'which-key/update)))
+ (run-with-idle-timer which-key-idle-delay t 'which-key//update)))
-(defun which-key/stop-open-timer ()
- "Deactivate idle timer for `which-key/update'."
+(defun which-key//stop-open-timer ()
+ "Deactivate idle timer for `which-key//update'."
(when which-key--open-timer (cancel-timer which-key--open-timer)))
(provide 'which-key)
projects / emacs.git / commitdiff